home *** CD-ROM | disk | FTP | other *** search
- /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
- /* ***** BEGIN LICENSE BLOCK *****
- * Version: MPL 1.1/GPL 2.0/LGPL 2.1
- *
- * The contents of this file are subject to the Mozilla Public License Version
- * 1.1 (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- * http://www.mozilla.org/MPL/
- *
- * Software distributed under the License is distributed on an "AS IS" basis,
- * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
- * for the specific language governing rights and limitations under the
- * License.
- *
- * The Original Code is mozilla.org code.
- *
- * The Initial Developer of the Original Code is
- * Netscape Communications Corporation.
- * Portions created by the Initial Developer are Copyright (C) 1998
- * the Initial Developer. All Rights Reserved.
- *
- * Contributor(s):
- *
- * Alternatively, the contents of this file may be used under the terms of
- * either of the GNU General Public License Version 2 or later (the "GPL"),
- * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
- * in which case the provisions of the GPL or the LGPL are applicable instead
- * of those above. If you wish to allow use of your version of this file only
- * under the terms of either the GPL or the LGPL, and not to allow others to
- * use your version of this file under the terms of the MPL, indicate your
- * decision by deleting the provisions above and replace them with the notice
- * and other provisions required by the GPL or the LGPL. If you do not delete
- * the provisions above, a recipient may use your version of this file under
- * the terms of any one of the MPL, the GPL or the LGPL.
- *
- * ***** END LICENSE BLOCK ***** */
-
- #include "nsISimpleEnumerator.idl"
-
- %{C++
- #define NS_ENUMERATOR_FALSE 1
- extern "C" NS_COM nsresult
- NS_NewEmptyEnumerator(nsISimpleEnumerator** aResult);
- %}
- /*
- * DO NOT USE THIS INTERFACE. IT IS HORRIBLY BROKEN, USES NS_COMFALSE
- * AND IS BASICALLY IMPOSSIBLE TO USE CORRECTLY THROUGH PROXIES OR
- * XPCONNECT. IF YOU SEE NEW USES OF THIS INTERFACE IN CODE YOU ARE
- * REVIEWING, YOU SHOULD INSIST ON nsISimpleEnumerator.
- *
- * DON'T MAKE ME COME OVER THERE.
- */
- [scriptable, uuid(ad385286-cbc4-11d2-8cca-0060b0fc14a3)]
- interface nsIEnumerator : nsISupports {
- /** First will reset the list. will return NS_FAILED if no items
- */
- void first();
-
- /** Next will advance the list. will return failed if already at end
- */
- void next();
-
- /** CurrentItem will return the CurrentItem item it will fail if the
- * list is empty
- */
- nsISupports currentItem();
-
- /** return if the collection is at the end. that is the beginning following
- * a call to Prev and it is the end of the list following a call to next
- */
- void isDone();
- };
-
- [uuid(75f158a0-cadd-11d2-8cca-0060b0fc14a3)]
- interface nsIBidirectionalEnumerator : nsIEnumerator {
-
- /** Last will reset the list to the end. will return NS_FAILED if no items
- */
- void last();
-
- /** Prev will decrement the list. will return failed if already at beginning
- */
- void prev();
- };
-